Eggplant DAI APIエンドポイント
DAI APIエンドポイントを使用して、モデルに関連するデータの大部分を取得および管理できます。これにより、他のプログラムやスクリプトから並行してモデルを実行し、テストの帯域幅を増やし、自動化フローを改善することが可能になります。また、Eggplant DAI Execution API Endpointsもご覧ください。
モデル関連データ
- Eggplant Functionalを介してシステムアンダーテスト(SUTs)にEggplant DAIサーバーを接続するエージェント
- アプリケーションを表すモデルおよびサブモデル
- 時間的パス深度およびパラメータークロス深度のためのカスタムカバレッジ定義を表すカバレッジモデル
- 失敗したモデルテストランのリストを提供する欠陥レポート
- タイミングとログを含むモデルテストランの履歴を提供するランレポート
- Eggplant DAIエンジンによって訪れたモデルのエリアを一部見ることができるカバレッジレポート
- モデルの失敗ポイントを特定するのに役立つスクリーンショット
- モデルを通じたユーザー定義のジャーニ ーすべてのテストケース
- モデルがどのようにテストされ、どのシステムアンダーテスト(SUT)に対してテストするかを定義するテスト設定タスク
- どのテストケースがヒットしたかを表示するテストラン
- バグハンティングを支援するためにモデルのさまざまな部分をカテゴライズするために使用されるタグ
- サードパーティプロバイダーからのデータを組み合わせ、スコアを計算して、アプリケーション品質を改善するためにどこに焦点を当てる必要があるかを予測するのを支援するインサイト
グローバルデータ
- 保護されたエンドポイントにアクセスするための認証トークンを生成する
- Eggplant DAIのユーザーを管理する
- グループを使用してユーザー間* グループを使用してユーザー間でモデルを共有する
- Eggplant DAIへのアクセスや複数のテストの並行実行のためのライセンスを生成する
- 利用統計を提供する
- APIが稼働しているかどうかをテストするためのPing
認証
Eggplant DAI APIのほとんどのエンドポイントは認証が必要です。したがって、有効なユーザーネームとパスワードを使用して/auth
エンドポイントにPOST
リクエストを行うことでアクセストークンを取得する必要があります。通常、アクセストークンの有効期限 は7日間で、期限が切れると、ユーザー制限があるエンドポイントから401 Unauthorized
レスポンスが返されます。これが発生した場合、/auth
エンドポイントから再度アクセストークンをリクエストしてください。典型的なレスポンスは以下の通りです:
{
"user_id": "97cf2b38-b9bf-426c-9293-b2c92f5b92f3",
"expires_in": 604800,
"access_type": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1NjE5NzczNTQsImV4cCI6MTU2MjU4MjE1NCwidXNlciI6eyJ1c2VybmFtZSI6Im1hcnRpbi5kYW5uQGVnZ3BsYW50LmlvIn0sImlzcyI6ImVnZ3BsYW50YWkuY29tIiwicmFuZCI6Nzg4ODY5OTQwMDQ5NDR9.Q8fp67rrMi32AEM6U-Hkulthh3-XXx6voSmEHsuwrgk",
"token_type": "bearer"
}
認可
ユーザー制限のあるエンドポイントは、すべてのAPIリクエストで認証ヘッダーに有効なアクセストークンが設定されていることが必要です。認証ヘッダーの形式はbearer {access token}
です。モデル関連のエンドポイントのような一部のエンドポイントは、それらにアクセスするために正しい権限を持っている必要があります。権限 はEggplant DAI内のグループの関連付けによって決定され、モデルはグループに関連付けられます。
Eggplant DAIに登録すると、ユーザーは各自の個別のグループに割り当てられ、それらは彼らのメールアドレスと同一の名前が付けられます。
ユーザーには2つの役割があります:一般ユーザーと管理者ユーザーです。管理者ユーザーは、一般ユーザーが持っていない追加のエンドポイント、たとえば、すべてのユーザー、すべてのモデル、その他のグローバル設定を管理するためのものにアクセスできます。また、管理者ユーザーは、モデルの共有を可能にするために追加のグループを作成することもできます。
エンドポイント
すべてのEggplant DAI APIエンドポイントのドキュメンテーションはSwaggerによって自動的に生成されます。これは、エンドポイントに渡す必要があるURL、HTTPメソッド、ヘッダー、本文パラメーター、および可能な応答のリストを提供します。